/*
 * Copyright 2012-2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.assertj.core.api.object2darray;

import static org.assertj.core.api.BDDAssertions.then;
import static org.assertj.core.description.EmptyTextDescription.emptyDescription;
import static org.assertj.core.error.ShouldHaveSameSizeAs.shouldHaveSameSizeAs;
import static org.assertj.core.error.ShouldNotBeNull.shouldNotBeNull;
import static org.assertj.core.error.SubarraysShouldHaveSameSize.subarraysShouldHaveSameSize;
import static org.assertj.core.error.array2d.Array2dElementShouldBeDeepEqual.elementShouldBeEqual;
import static org.assertj.core.presentation.StandardRepresentation.STANDARD_REPRESENTATION;
import static org.assertj.core.util.AssertionsUtil.expectAssertionError;

import org.assertj.core.api.Object2DArrayAssert;
import org.assertj.core.error.ErrorMessageFactory;
import org.assertj.core.testkit.Person;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

/**
 * Tests for <code>{@link Object2DArrayAssert#isDeepEqualTo(Object[][])}</code>.
 *
 * @author Maciej Wajcht
 */
@DisplayName("Object2DArrayAssert isDeepEqualTo")
class Object2DArrayAssert_isDeepEqualTo_Test {

  @Test
  void should_pass_if_both_actual_and_expected_are_null() {
    // GIVEN
    String[][] actual = null;
    String[][] expected = null;
    // WHEN/THEN
    then(actual).isDeepEqualTo(expected);
  }

  @Test
  void should_pass_if_both_actual_and_expected_are_same_arrays() {
    // GIVEN
    String[][] actual = new String[][] { { "1", "2" }, { "3" }, { "4", "5", "6" } };
    String[][] expected = actual;
    // WHEN/THEN
    then(actual).isDeepEqualTo(expected);
  }

  @Test
  void should_pass_if_both_actual_and_expected_have_same_references() {
    // GIVEN
    String[][] actual = new String[][] { { "1", "2" }, { "3" }, { "4", "5", "6" } };
    String[][] expected = new String[][] { { "1", "2" }, { "3" }, { "4", "5", "6" } };
    // WHEN/THEN
    then(actual).isDeepEqualTo(expected);
  }

  @Test
  void should_pass_if_both_actual_and_expected_are_equal() {
    // GIVEN
    Person[][] actual = new Person[][] {
        { new Person("Homer"), new Person("Marge") },
        { new Person("Liza"), new Person("Bart"), new Person("Maggie") },
        { null, null }
    };
    Person[][] expected = new Person[][] {
        { new Person("Homer"), new Person("Marge") },
        { new Person("Liza"), new Person("Bart"), new Person("Maggie") },
        { null, null }
    };
    // WHEN/THEN
    then(actual).isDeepEqualTo(expected);
  }

  @Test
  void should_pass_with_three_dimensional_equal_arrays() {
    // GIVEN
    Person[][][] actual = new Person[][][] {
        {
            { new Person("Homer"), new Person("Marge") },
            { new Person("Liza"), new Person("Bart"), new Person("Maggie") },
            { null, null }
        },
        {
            { new Person("Apu"), new Person("Ned"), new Person("Milhouse") }
        },
    };
    Person[][][] expected = new Person[][][] {
        {
            { new Person("Homer"), new Person("Marge") },
            { new Person("Liza"), new Person("Bart"), new Person("Maggie") },
            { null, null }
        },
        {
            { new Person("Apu"), new Person("Ned"), new Person("Milhouse") }
        },
    };
    // WHEN/THEN
    then(actual).isDeepEqualTo(expected);
  }

  @Test
  void should_fail_if_actual_is_null() {
    // GIVEN
    String[][] actual = null;
    String[][] expected = new String[][] { { "1", "2" }, { "3" }, { "4", "5", "6" } };
    // WHEN
    var assertionError = expectAssertionError(() -> then(actual).isDeepEqualTo(expected));
    // THEN
    then(assertionError).hasMessage(shouldNotBeNull().create());
  }

  @Test
  void should_fail_if_actual_in_second_dimension_is_null() {
    // GIVEN
    String[][] actual = new String[][] { { "1", "2" }, null, { "4", "5", "6" } };
    String[][] expected = new String[][] { { "1", "2" }, { "3" }, { "4", "5", "6" } };
    // WHEN
    var assertionError = expectAssertionError(() -> then(actual).isDeepEqualTo(expected));
    // THEN
    then(assertionError).hasMessage(shouldNotBeNull("actual[1]").create());
  }

  @Test
  void should_fail_if_first_dimension_size_is_different() {
    // GIVEN
    String[][] actual = new String[][] { { "1", "2" }, { "3" } };
    String[][] expected = new String[][] { { "1", "2" }, { "3" }, { "4", "5", "6" } };
    // WHEN
    var assertionError = expectAssertionError(() -> then(actual).isDeepEqualTo(expected));
    // THEN
    then(assertionError).hasMessage(shouldHaveSameSizeAs(actual, expected, actual.length, expected.length).create());
  }

  @Test
  void should_fail_if_second_dimension_size_is_different() {
    // GIVEN
    String[][] actual = new String[][] { { "1", "2" }, { "3", "XXX" }, { "4", "5", "6" } };
    String[][] expected = new String[][] { { "1", "2" }, { "3" }, { "4", "5", "6" } };
    String[] actualSubArrayWithDifference = new String[] { "3", "XXX" };
    String[] expectedSubArrayWithDifference = new String[] { "3" };
    // WHEN
    var assertionError = expectAssertionError(() -> then(actual).isDeepEqualTo(expected));
    // THEN
    ErrorMessageFactory subarraysShouldHaveSameSize = subarraysShouldHaveSameSize(actual, expected,
                                                                                  actualSubArrayWithDifference,
                                                                                  actualSubArrayWithDifference.length,
                                                                                  expectedSubArrayWithDifference,
                                                                                  expectedSubArrayWithDifference.length,
                                                                                  1);
    then(assertionError).hasMessage(subarraysShouldHaveSameSize.create());
  }

  @Test
  void should_fail_if_one_value_in_second_dimension_is_different() {
    // GIVEN
    String actualValue = "XXX";
    String expectedValue = "3";
    String[][] actual = new String[][] { { "1", "2" }, { actualValue }, { "4", "5", "6" } };
    String[][] expected = new String[][] { { "1", "2" }, { expectedValue }, { "4", "5", "6" } };
    // WHEN
    var assertionError = expectAssertionError(() -> then(actual).isDeepEqualTo(expected));
    // THEN
    ErrorMessageFactory elementShouldBeEqual = elementShouldBeEqual(actualValue, expectedValue, 1, 0);
    then(assertionError).hasMessage(elementShouldBeEqual.create(emptyDescription(), STANDARD_REPRESENTATION));
  }
}
